Vcenter Tokenservice TokenExchange ExchangeSpec

Vcenter Tokenservice TokenExchange ExchangeSpec
Vcenter Tokenservice TokenExchange ExchangeSpec

This schema is deprecated as of vSphere API 7.0.2.0.

The Vcenter Tokenservice TokenExchange ExchangeSpec schema contains arguments required for token exchange.

This schema was added in vSphere API 7.0.0.0.

JSON Example
{
    "grant_type": "string",
    "resource": "string",
    "audience": "string",
    "scope": "string",
    "requested_token_type": "string",
    "subject_token": "string",
    "subject_token_type": "string",
    "actor_token": "string",
    "actor_token_type": "string"
}
string
grant_type
Required

This property is deprecated as of vSphere API 7.0.2.0.

The value of Vcenter Tokenservice TokenExchange.TOKEN_EXCHANGE_GRANT indicates that a token exchange is being performed.

This property was added in vSphere API 7.0.0.0.

string
resource
Optional

This property is deprecated as of vSphere API 7.0.2.0.

Indicates the location of the target service or resource where the client intends to use the requested security token.

This property was added in vSphere API 7.0.0.0.

if can be inferred from other arguments or not needed for specific case of exchange.

string
audience
Optional

This property is deprecated as of vSphere API 7.0.2.0.

The logical name of the target service where the client intends to use the requested security token. This serves a purpose similar to the Vcenter Tokenservice TokenExchange ExchangeSpec.resource parameter, but with the client providing a logical name rather than a location.

This property was added in vSphere API 7.0.0.0.

if can be inferred from other arguments or not needed for specific case of exchange.

string
scope
Optional

This property is deprecated as of vSphere API 7.0.2.0.

A list of space-delimited, case-sensitive strings, that allow the client to specify the desired scope of the requested security token in the context of the service or resource where the token will be used.

This property was added in vSphere API 7.0.0.0.

if can be inferred from other arguments or not needed for specific case of exchange.

string
requested_token_type
Optional

This property is deprecated as of vSphere API 7.0.2.0.

An identifier for the type of the requested security token. If the requested type is unspecified, the issued token type is at the discretion of the server and may be dictated by knowledge of the requirements of the service or resource indicated by the Vcenter Tokenservice TokenExchange ExchangeSpec.resource or Vcenter Tokenservice TokenExchange ExchangeSpec.audience parameter.

This property was added in vSphere API 7.0.0.0.

if can be inferred from other arguments or not needed for specific case of exchange.

string
subject_token
Required

This property is deprecated as of vSphere API 7.0.2.0.

A security token that represents the identity of the party on behalf of whom exchange is being made. Typically, the subject of this token will be the subject of the security token issued. Token is base64-encoded.

This property was added in vSphere API 7.0.0.0.

string
subject_token_type
Required

This property is deprecated as of vSphere API 7.0.2.0.

An identifier, that indicates the type of the security token in the Vcenter Tokenservice TokenExchange ExchangeSpec.subject_token parameter.

This property was added in vSphere API 7.0.0.0.

string
actor_token
Optional

This property is deprecated as of vSphere API 7.0.2.0.

A security token that represents the identity of the acting party. Typically, this will be the party that is authorized to use the requested security token and act on behalf of the subject.

This property was added in vSphere API 7.0.0.0.

if not needed for specific case of exchange.

string
actor_token_type
Optional

This property is deprecated as of vSphere API 7.0.2.0.

An identifier, that indicates the type of the security token in the Vcenter Tokenservice TokenExchange ExchangeSpec.actor_token parameter.

This property was added in vSphere API 7.0.0.0.

if Vcenter Tokenservice TokenExchange ExchangeSpec.actor_token parameter is not present.

Deprecated